CASI API - Scheme Instance

Gets the details of a specific scheme and the assigned personas for the authenticated user

Path Parameters

Parameter	Description
scheme	Scheme ID number

Get Scheme Details GET

Gets the basic details for this scheme, including the personas through which the current authenticated user may access scheme data.

If the user is administrator for a certification body; or has been appointed as an inspector for a certification body then the certifier-specific access rights are detailed under Certifier Access.

Parameters

Response Parameters

Parameter	Name	Type	Description
SchemeName	Scheme Name	String (Optional)
SchemeLogoLarge	Large Scheme Logo	String (Optional)	The path to a scheme logo of up to 128 x 128px in size
SchemeLogoSmall	Small Scheme Logo	String (Optional)	The path to a scheme logo of up to 32 x 32px in size
Personas	Personas	Enumeration (Optional)
Certifiers	Certifier Access	List (Optional)
CertifierID	Certifier Identifier	Number	The unique numeric identifier assigned to the certification body
CertifierName	Certifier Name	String	The name of the certification body
CertifierPersonas	Certifier Personas	Enumeration (Optional)	The personas through which the user can access scheme members assigned to a specific certifier

Enumerations

Personas (Response)

Value	Description
Manager	User has scheme manager role
Administrator	User has scheme administrator role
Author	User has standards author role
Certifier	User has certifier administrator role
Industry	User has scheme industry access
Member	User is associated with a scheme member
Inspector	User has inspector role

Certifier Personas (Response)

Value	Description
Manager	User has scheme manager role
Administrator	User has scheme administrator role
Certifier	User has certifier administrator role
Inspector	User has inspector role

XML

Example Request

GET https://api.casi.services/v1/schemes/{scheme}.eb HTTP/1.1
Accept: text/xml

Response Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="SchemeDetails">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="SchemeName" minOccurs="0" type="xsd:string" />
        <xsd:element name="SchemeLogoLarge" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The path to a scheme logo of up to 128 x 128px in size</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="SchemeLogoSmall" minOccurs="0" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The path to a scheme logo of up to 32 x 32px in size</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="Personas" minOccurs="0">
          <xsd:simpleType>
            <xsd:list>
              <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                  <xsd:enumeration value="Manager">
                    <xsd:annotation>
                      <xsd:documentation>User has scheme manager role</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                  <xsd:enumeration value="Administrator">
                    <xsd:annotation>
                      <xsd:documentation>User has scheme administrator role</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                  <xsd:enumeration value="Author">
                    <xsd:annotation>
                      <xsd:documentation>User has standards author role</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                  <xsd:enumeration value="Certifier">
                    <xsd:annotation>
                      <xsd:documentation>User has certifier administrator role</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                  <xsd:enumeration value="Industry">
                    <xsd:annotation>
                      <xsd:documentation>User has scheme industry access</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                  <xsd:enumeration value="Member">
                    <xsd:annotation>
                      <xsd:documentation>User is associated with a scheme member</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                  <xsd:enumeration value="Inspector">
                    <xsd:annotation>
                      <xsd:documentation>User has inspector role</xsd:documentation>
                    </xsd:annotation>
                  </xsd:enumeration>
                </xsd:restriction>
              </xsd:simpleType>
            </xsd:list>
          </xsd:simpleType>
        </xsd:element>
        <xsd:element name="Certifiers" minOccurs="0">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="CertifierID" type="xsd:double">
                      <xsd:annotation>
                        <xsd:documentation>The unique numeric identifier assigned to the certification body</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="CertifierName" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The name of the certification body</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="CertifierPersonas" minOccurs="0">
                      <xsd:annotation>
                        <xsd:documentation>The personas through which the user can access scheme members assigned to a specific certifier</xsd:documentation>
                      </xsd:annotation>
                      <xsd:simpleType>
                        <xsd:list>
                          <xsd:simpleType>
                            <xsd:restriction base="xsd:string">
                              <xsd:enumeration value="Manager">
                                <xsd:annotation>
                                  <xsd:documentation>User has scheme manager role</xsd:documentation>
                                </xsd:annotation>
                              </xsd:enumeration>
                              <xsd:enumeration value="Administrator">
                                <xsd:annotation>
                                  <xsd:documentation>User has scheme administrator role</xsd:documentation>
                                </xsd:annotation>
                              </xsd:enumeration>
                              <xsd:enumeration value="Certifier">
                                <xsd:annotation>
                                  <xsd:documentation>User has certifier administrator role</xsd:documentation>
                                </xsd:annotation>
                              </xsd:enumeration>
                              <xsd:enumeration value="Inspector">
                                <xsd:annotation>
                                  <xsd:documentation>User has inspector role</xsd:documentation>
                                </xsd:annotation>
                              </xsd:enumeration>
                            </xsd:restriction>
                          </xsd:simpleType>
                        </xsd:list>
                      </xsd:simpleType>
                    </xsd:element>
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<SchemeDetails>
  <SchemeName>xsd:string</SchemeName>
  <SchemeLogoLarge>xsd:string</SchemeLogoLarge>
  <SchemeLogoSmall>xsd:string</SchemeLogoSmall>
  <Personas>xsd:string</Personas>
  <Certifiers>
    <Item>
      <CertifierID>xsd:double</CertifierID>
      <CertifierName>xsd:string</CertifierName>
      <CertifierPersonas>xsd:string</CertifierPersonas>
    </Item>...</Certifiers>
</SchemeDetails>

Download full schema

JSON

Example Request

GET https://api.casi.services/v1/schemes/{scheme}.eb HTTP/1.1
Accept: application/json

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{"SchemeName":String,
  "SchemeLogoLarge":String,
  "SchemeLogoSmall":String,
  "Personas":String,
  "Certifiers":[{"CertifierID":Number,
      "CertifierName":String,
      "CertifierPersonas":String},
    ...]}